Allow SQL backends to use a custom migrations table - #485
Open
rmorlok wants to merge 4 commits into
Open
Conversation
Allow SQL backends to use a custom migrations table
There was a problem hiding this comment.
Pull request overview
This PR adds a configurable migrations bookkeeping table for the SQLite and PostgreSQL backends so applications sharing a database (and already using golang-migrate’s default schema_migrations) can avoid collisions while keeping go-workflows’ operational tables unchanged.
Changes:
- Add
WithMigrationsTable(...)options for SQLite and PostgreSQL backends. - Wire the configured table name into the golang-migrate driver config (
sqlite.Config/postgres.Config). - Add tests covering the shared-database scenario where
schema_migrationsis pre-owned by the embedding application, and update backend docs.
Show a summary per file
| File | Description |
|---|---|
| docs/source/includes/_backends.md | Documents the new WithMigrationsTable backend option for SQLite/PostgreSQL. |
| backend/sqlite/sqlite.go | Passes configured migrations table into golang-migrate’s SQLite driver config. |
| backend/sqlite/sqlite_test.go | Adds a test verifying custom migrations table avoids touching existing schema_migrations. |
| backend/sqlite/options.go | Introduces MigrationsTable option and WithMigrationsTable setter for SQLite. |
| backend/postgres/postgres.go | Passes configured migrations table into golang-migrate’s Postgres driver config. |
| backend/postgres/postgres_test.go | Adds a test verifying custom migrations table avoids touching existing schema_migrations. |
| backend/postgres/options.go | Introduces MigrationsTable option and WithMigrationsTable setter for Postgres. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 7/7 changed files
- Comments generated: 1
Comment on lines
+48
to
49
| - `WithMigrationsTable(migrationsTable string)` - Set the table used to track applied migrations. Defaults to golang-migrate's standard migration table. | ||
| - `WithBackendOptions(opts ...backend.BackendOption)` - Apply generic backend options |
Author
There was a problem hiding this comment.
Sorry about that. My codebase didn't use MySQL so my agent must've missed that. Happy to push a fix if you want.
Author
There was a problem hiding this comment.
I pushed a change with the mysql support.
Allow MySQL backend to use a custom migrations table
Author
|
@cschleiden wondering if you had a chance to take a look at this PR 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applications embedding go-workflows within their primary application may want to share the main application database with go-workflows. If they use go-migrate, today they will collide with the schema migrations table. Provide an option in go-workflows to specify which table should be used to avoid the conflict.
Refs rmorlok/authproxy#539